<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilsecure: xsecure_plat_rsa.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilsecure
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xsecure__plat__rsa_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xsecure_plat_rsa.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains Versal Net specific code for Xilsecure rsa server. </p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who     Date     Changes
</p>
<hr/>
<p>
5.2   kpt     06/23/23 Initial release
5.3   am      09/28/23 Added wrapper functions for IPCore's RSA APIs
      dd      10/11/23 MISRA-C violation Rule 10.3 fixed
      dd      10/11/23 MISRA-C violation Rule 12.1 fixed
      dd      10/11/23 MISRA-C violation Rule 8.13 fixed
      kpt     12/13/23 Added RSA CRT support for RSA keyunwrap
5.3   ng      01/28/24 Added SDT support
      ng      03/26/24 Fixed header include in SDT flow
      kpt     03/22/24 Fix MISRA C violation of Rule 10.3
5.4   yog     04/29/24 Fixed doxygen warnings.
      kpt     05/26/24 Added RSA Expopt API.
      kpt     06/13/24 Add support for RSA key generation.
      kpt     07/04/24 Add major error code for RSA key pair generation.
      kal     07/24/24 Code refactoring changes for versal_2ve_2vm
      mb      10/14/24 Removed duplicate definitions</pre><pre></pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga4d44ea80e5d3318fa89cfb81c19a8bab"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__rsa__server__apis.html#ga4d44ea80e5d3318fa89cfb81c19a8bab">XSECURE_RSA_MAX_MSG_SIZE_IN_BYTES</a></td></tr>
<tr class="memdesc:ga4d44ea80e5d3318fa89cfb81c19a8bab"><td class="mdescLeft">&#160;</td><td class="mdescRight">RSA maximum message size in bytes.  <a href="group__xsecure__rsa__server__apis.html#ga4d44ea80e5d3318fa89cfb81c19a8bab">More...</a><br/></td></tr>
<tr class="separator:ga4d44ea80e5d3318fa89cfb81c19a8bab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1cf3919ee718dd93e02bb36a43e55cba"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__rsa__server__apis.html#ga1cf3919ee718dd93e02bb36a43e55cba">XSECURE_RSA_MAX_PS_SIZE_IN_BYTES</a>&#160;&#160;&#160;(<a class="el" href="group__xsecure__rsa__server__apis.html#ga4d44ea80e5d3318fa89cfb81c19a8bab">XSECURE_RSA_MAX_MSG_SIZE_IN_BYTES</a>)</td></tr>
<tr class="memdesc:ga1cf3919ee718dd93e02bb36a43e55cba"><td class="mdescLeft">&#160;</td><td class="mdescRight">RSA maximum PS size in bytes.  <a href="group__xsecure__rsa__server__apis.html#ga1cf3919ee718dd93e02bb36a43e55cba">More...</a><br/></td></tr>
<tr class="separator:ga1cf3919ee718dd93e02bb36a43e55cba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga59042ddf231be62c14ab4a7c62802f0b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__rsa__server__apis.html#ga59042ddf231be62c14ab4a7c62802f0b">XSECURE_RSA_MAX_DB_SIZE_IN_BYTES</a></td></tr>
<tr class="memdesc:ga59042ddf231be62c14ab4a7c62802f0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">RSA maximum DB size in bytes.  <a href="group__xsecure__rsa__server__apis.html#ga59042ddf231be62c14ab4a7c62802f0b">More...</a><br/></td></tr>
<tr class="separator:ga59042ddf231be62c14ab4a7c62802f0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gab519747faf9ccf8e016d20e5713838c9"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__rsa__server__apis.html#gab519747faf9ccf8e016d20e5713838c9">XSecure_RsaOaepEncrypt</a> (<a class="el" href="struct_x_secure___rsa.html">XSecure_Rsa</a> *InstancePtr, <a class="el" href="struct_x_secure___rsa_oaep_param.html">XSecure_RsaOaepParam</a> *OaepParam)</td></tr>
<tr class="memdesc:gab519747faf9ccf8e016d20e5713838c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function encodes the given message using RSA OAEP and encrypts it.  <a href="group__xsecure__rsa__server__apis.html#gab519747faf9ccf8e016d20e5713838c9">More...</a><br/></td></tr>
<tr class="separator:gab519747faf9ccf8e016d20e5713838c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7fe869dab6a634c2866f9ec26ee8cec0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__rsa__server__apis.html#ga7fe869dab6a634c2866f9ec26ee8cec0">XSecure_RsaOaepDecrypt</a> (XSecure_RsaPrivKey *PrivKey, <a class="el" href="struct_x_secure___rsa_oaep_param.html">XSecure_RsaOaepParam</a> *OaepParam)</td></tr>
<tr class="memdesc:ga7fe869dab6a634c2866f9ec26ee8cec0"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function decodes the given message and decrypts it using RSA OAEP.  <a href="group__xsecure__rsa__server__apis.html#ga7fe869dab6a634c2866f9ec26ee8cec0">More...</a><br/></td></tr>
<tr class="separator:ga7fe869dab6a634c2866f9ec26ee8cec0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga164469228a4eea6357072fee975418de"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__rsa__server__apis.html#ga164469228a4eea6357072fee975418de">XSecure_AddRsaKeyPairGenerationToScheduler</a> (void)</td></tr>
<tr class="memdesc:ga164469228a4eea6357072fee975418de"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function adds periodic task of generation RSA key pair to scheduler.  <a href="group__xsecure__rsa__server__apis.html#ga164469228a4eea6357072fee975418de">More...</a><br/></td></tr>
<tr class="separator:ga164469228a4eea6357072fee975418de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabc66468fdd66a559fa567f631fbae91c"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__rsa__server__apis.html#gabc66468fdd66a559fa567f631fbae91c">XSecure_GetRsaKeyInUseIdx</a> (void)</td></tr>
<tr class="memdesc:gabc66468fdd66a559fa567f631fbae91c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns RSA key inuse index.  <a href="group__xsecure__rsa__server__apis.html#gabc66468fdd66a559fa567f631fbae91c">More...</a><br/></td></tr>
<tr class="separator:gabc66468fdd66a559fa567f631fbae91c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga547d58774dd7e1821688203999e1b5e2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__rsa__server__apis.html#ga547d58774dd7e1821688203999e1b5e2">XSecure_RsaDestroyKeyInUse</a> (void)</td></tr>
<tr class="memdesc:ga547d58774dd7e1821688203999e1b5e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function destroys the RSA key in use.  <a href="group__xsecure__rsa__server__apis.html#ga547d58774dd7e1821688203999e1b5e2">More...</a><br/></td></tr>
<tr class="separator:ga547d58774dd7e1821688203999e1b5e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga76632037ef8961e99b8b9b210d5f75f1"><td class="memItemLeft" align="right" valign="top">XSecure_RsaPrivKey *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__rsa__server__apis.html#ga76632037ef8961e99b8b9b210d5f75f1">XSecure_GetRsaPrivateKey</a> (u32 RsaIdx)</td></tr>
<tr class="memdesc:ga76632037ef8961e99b8b9b210d5f75f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns RSA private key.  <a href="group__xsecure__rsa__server__apis.html#ga76632037ef8961e99b8b9b210d5f75f1">More...</a><br/></td></tr>
<tr class="separator:ga76632037ef8961e99b8b9b210d5f75f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa40ad2688c9e7d2e756a29fa88bfaa27"><td class="memItemLeft" align="right" valign="top">XSecure_RsaPubKey *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__rsa__server__apis.html#gaa40ad2688c9e7d2e756a29fa88bfaa27">XSecure_GetRsaPublicKey</a> (u32 RsaIdx)</td></tr>
<tr class="memdesc:gaa40ad2688c9e7d2e756a29fa88bfaa27"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns RSA public key.  <a href="group__xsecure__rsa__server__apis.html#gaa40ad2688c9e7d2e756a29fa88bfaa27">More...</a><br/></td></tr>
<tr class="separator:gaa40ad2688c9e7d2e756a29fa88bfaa27"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
